Pressing directly on the icon will insert a code block with the language
that was selected most recently. If this is the first time a code block
is inserted, the language will be “Auto-detected” by default.
Pressing the arrow next to the icon, which will show a popup with the
available languages.
Type ``` (as in Markdown).
Note that it's not possible to specify the language, as it will default
to the last selected language.
Exiting out of the code block
To exit out of a code block and enter a normal paragraph, move the cursor
at the end of the code block and press Enter twice.
Similarly, to insert a paragraph above the note block, move the cursor
at the beginning of the code block and press Enter twice.
Syntax highlighting & color schemes
Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting
to the code block. Note that the syntax highlighting mechanism is slightly
different than the one in Code notes
as different technologies are involved.
Interaction:
When the language is set to Auto-detected (by default), Trilium
will try to identify the programming language (or similar) that corresponds
to the given snippet of text and highlight it. Only the languages enabled
in Options → Code Notes → Available MIME types in the dropdown are
considered. If this is problematic, consider changing the language of the
code block manually.
When the language is set to Plain text, there will be no syntax
highlighting.
Note that when editing a text note, syntax highlighting is automatically
disabled if the code block is too big (somewhere around 500 lines). This
value is currently not configurable. For Read-Only Notes, this limitation is
not applied.
In order to configure this new feature, a section has been added in Options → Appearance to
control the syntax highlighting. There the color scheme can be chosen,
from a builtin selection of themes from Highlight.js.
It is possible to disable the syntax highlighting for all the notes by
selecting “No syntax highlighting” in the “Color scheme” option.
Word wrapping is disabled by default, but can be configured from the same
section.
The tab width can also be adjusted from Options.
Migrating from existing syntax highlight plugins
If you are already using a syntax highlighting plugin such as the Trilium-SyntaxHighlightWidget we
are basing off of, it is important to disable that plugin before upgrading
in order for it not to conflict with our implementation.
Should you encounter any issues after the migration, try running Trilium
in safe mode.
Changing the language of a code block
Simply click anywhere inside the code block and press again the code block
button in the Formatting toolbar:
Adjusting the list of languages
The code blocks feature shares the list of languages with the Code note
type.
The supported languages can be adjusted by going to Options, then Code Notes and
looking for the Available MIME types in the dropdown section. Simply
check any of the items to add them to the list, or uncheck them to remove
them from the list.
Note that the list of languages is not immediately refreshed, you'd have
to manually refresh the application.
Text replacements and ligatures
Automatic replacements are
a feature of text notes which converts some character sequences into another
and some of them interfere with programming text, such as the conversion
of quotes. While in a code block, the automatic replacements are not effect.
The only way the automatic replacements can interfere is if the text is
typed/pasted before being put in a code block.
A different feature is programming ligatures, which is simply
a display affordance which turns != into ≠ or -> as → .
These come from the font. The underlying
text is not actually changed, and copying it out gives you back != and ->.
Ligatures can be disabled in Options→ Appearance → Fonts → Programming ligatures.
